Skip to content

Docs: Enable documentation section of website#95

Draft
esnible wants to merge 2 commits into
rossoctl:mainfrom
esnible:enable-documentation-section
Draft

Docs: Enable documentation section of website#95
esnible wants to merge 2 commits into
rossoctl:mainfrom
esnible:enable-documentation-section

Conversation

@esnible

@esnible esnible commented Jul 23, 2026

Copy link
Copy Markdown
Member

Summary

Currently the 'Documentation' section of the website is disabled.

This enables the section, plus a few small changes I needed to make it render correctly.

(Optional) Testing Instructions

Do SRC_REPO=~/src/rossoctl npm run sync-docs && npm run build && npm run serve
(modify the SRC_REPO if your clone of rossoctl is elsewhere)

Note that we need to build because we are using the draft feature to exclude content we don't want on the website.

Signed-off-by: Ed Snible <snible@us.ibm.com>
@netlify

netlify Bot commented Jul 23, 2026

Copy link
Copy Markdown

Deploy Preview for animated-crumble-fb8862 ready!

Name Link
🔨 Latest commit 9e45102
🔍 Latest deploy log https://app.netlify.com/projects/animated-crumble-fb8862/deploys/6a635e13feb9b40008924dd4
😎 Deploy Preview https://deploy-preview-95--animated-crumble-fb8862.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: Ed Snible <snible@us.ibm.com>

@mrsabath mrsabath left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean enablement of the website Docs section, now that #2253 provides the reorganized + draft-gated content. Flips docs: false → enabled, restores the Documentation navbar item, wraps the sidebar in a generated-index root category, and teaches sync-docs.sh to slug the synced README.md so it doesn't collide with the generated-index root route.

Verified against the current repo + #2253:

  • Status/pill parity: welcome.mdx uses exactly Ready / beta in 0.7 / alpha in 0.7, and STATUS_CLASS maps all three — no orphaned status or dead map key (plus a ?? '' fallback for safety).
  • CTA route valid: /docs/overview/quickstart resolves — routeBasePath: 'docs' and quickstart exists in #2253, not draft-gated.
  • sync-docs README slug handling is well-reasoned: guards against pre-existing frontmatter and keeps the README→index link rewrite so cross-links don't break.

Verdict: APPROVE — correct enablement, verified parity and route, sound sync handling.

Minor (non-blocking, no change needed): the empty exclude: [] block is a leftover scaffold with stray whitespace; the dropped "Try RossoCortex" CTA reads as a deliberate content choice now that docs are live.

Depends on #2253 (the content source — approved and green); merge it first so the synced docs/ exists at build time.

Areas reviewed: Docusaurus config/sidebar, sync-docs shell, React component (status-map parity), content. Commits: 2, signed-off. CI: passing.

@esnible
esnible marked this pull request as draft July 24, 2026 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: New/ToDo

Development

Successfully merging this pull request may close these issues.

3 participants